home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / todaydor.zip / TODAYDOR.DOC < prev    next >
Text File  |  1992-12-19  |  10KB  |  200 lines
  1.  
  2.                                 TODAYDOR
  3.                                 ++++++++
  4.  
  5.                     version 3.20, by Michael Conley
  6.     released  12/19/92 from the Charlatan's Cabin BBS, Los Angeles, CA.
  7.  
  8. TODAYDOR is designed to be run as a live DOOR program on Wildcat! 3.x and 2.x 
  9. systems which are already running my TODAYBBS program.  It allows your users 
  10. to look up any day of the year and view a collection of historical facts, 
  11. birthdays, etc.  If you choose, it will also display the names of any system 
  12. users born on the selected date, provided you periodically run a companion 
  13. program called BDAYPREP, to create a data file accessible to TODAYDOR.  
  14. BDAYPREP.ZIP is NOT included here but is probably available where you got
  15. TODAYDOR, TODAYBBS, or any of my other Wildcat! SysOp utilities. 
  16.  
  17. SETTING UP A DOOR:
  18. ================== 
  19. The Wildcat! manual and other tutorials have done a fine job of explaining
  20. how to set up a door on your BBS.  Therefore I won't re-invent the wheel by
  21. going through all of the directory naming and batch file creating necessary
  22. to execute TODAYDOR.  
  23.  
  24. It's important to note that TODAYDOR will check the CURRENT directory (where
  25. your DOOR program is started) for either DOOR.SYS or CALLINFO.BBS.  Wildcat!
  26. version 3.x creates DOOR.SYS; earlier versions created CALLINFO.BBS.  On my
  27. system, I have a directory called DOORS, and my batch file copies DOOR.SYS
  28. into that directory, then change to that directory, then start TODAYDOR.
  29.  
  30. TODAYDOR also needs ENVIRONMENT VARIABLES:  These are used by Wildcat! 3.x
  31. and will be ignored by Wildcat! 2.x, but they MUST be present for each node
  32. of your Wildcat! system in order for TODAYDOR to function properly:
  33.  
  34. SET WCPORTID=2     < put these lines in your Wildcat! startup batch file and
  35. SET WCIRQID=3      <   check to be sure they are added to your environment.
  36.  
  37. If you have a non-standard port address, you'll need to provide an additional
  38. environment variable with the DECIMAL port address:
  39.  
  40. SET COMBASE=1016  << substitute your correct decimal port address here.
  41.  
  42. That will override the default address of the port number specified in 
  43. WCPORTID.   WCIRQID will still need to be set to the correct interrupt
  44. value.  TODAYDOR supports IRQs 2-15.
  45.  
  46. A sample batch file for Wildcat! version 3.x would look something like this:
  47.  
  48. REM this is a sample batch file for TODAYDOR with Wildcat! 3.x
  49. REM this assumes you SHELL to your doors.  If you TERMINATE, you
  50. REM need to add a change-directory back to your startup directory
  51. REM and then run your startup batch file.
  52. ECHO OFF
  53. COPY C:\WC30\WCWORK\NODE%WCNODEID%\DOOR.SYS C:\WC30\DOORS\DOOR.SYS
  54. CD C:\WC30\DOORS
  55. TODAYDOR
  56. EXIT    
  57.  
  58. A sample batch file for Wildcat! version 2.x would look something like this:
  59.  
  60. REM this is a sample batch file for TODAYDOR with Wildcat! 2.x
  61. ECHO OFF
  62. CD \DOORS
  63. COPY C:\CAT\NODE1\CALLINFO.BBS C:\DOORS\CALLINFO.BBS
  64. TODAYDOR
  65. CD \CAT\NODE1
  66. NODE1.BAT
  67.  
  68. Note that TODAYDOR monitors time online and Carrier Detect, and will close
  69. and exit gracefully back to the node if the caller drops offline while in
  70. the door.
  71.  
  72. PREPARING TODAYDOR:
  73. ===================
  74. It's necessary to create a configuration file for TODAYDOR, named TODAYDOR.CFG,
  75. which must reside in the directory where you'll start TODAYDOR.  Hers is a
  76. sample configuration file:
  77.  
  78. BBSNAME=The Charlatan's Cabin BBS
  79. CTSCHECK=YES
  80. FOSSIL=NO
  81. TODAY=C:\TODAY\
  82.  
  83. You may edit this file as desired, following these guidelines:
  84.  
  85.         BBSNAME= the name of your BBS as you want it to appear in
  86.                  the program's displays.
  87.  
  88.         CTSCHECK= Indicate YES or NO ... do you want the program to
  89.                   check for Clear to Send?  Default is YES if this
  90.                   line isn't found.
  91.  
  92.         FOSSIL=   Indicate YES or NO ... do you want the program to
  93.                   redirect COM calls to INT 14h?  If you're not using
  94.                   a FOSSIL driver, set this to NO.
  95.  
  96.         TODAY=    the complete Path to your TODAY.xxx files, where the 
  97.                   monthly data is stored.  To run TODAYDOR, you'll need
  98.                   data for each month of the year.  See the DOC file for
  99.                   details on downloading these files.  
  100.  
  101.                   User birthday data will be read from this same directory, 
  102.                   if you use BDAYPREP to create "TODAY.BIR" in this directory.
  103.  
  104.                   NOTE that if you DON'T want user birthdays included in the 
  105.                   display, you simply DON'T CREATE the TODAY.BIR file in the 
  106.                   directory with your other TODAY data files and TODAYDOR will 
  107.                   skip over that step.
  108.  
  109. HISTORICAL DATA:
  110. ================
  111. TODAYDOR uses the same historical data files used by TODAYBBS.  The files
  112. are maintained by Bruce Goldsmith and are available from the Charlatan's Cabin.
  113. There are 6 files, called DAY9xx-#.ZIP, where the 9xx is the series number,
  114. currently 905, and the # is the file number, 1 through 6.  Each contains two
  115. months' worth of data ... File "DAY907-2.ZIP" for example, contains MARCH and
  116. APRIL.  All files are available at the Cabin (213) 654-7337. There is no charge
  117. for access, and these files can be downloaded without joining the BBS.  You must, 
  118. of course, unZIP the files and place them in the directory you named in the 
  119. configuration file.
  120.  
  121. LOCAL SYSTEM FILE:
  122. ==================
  123. TODAYDOR will search for a file in your TODAY datafiles directory named
  124. TODAY.LCL.  If found, it will read the file and incorporate any qualifying
  125. entries in the output for the selected date.  This will appear before the
  126. main data entries.  
  127.  
  128. USER BIRTHDAYS:
  129. ===============
  130. Wildcat! user birthdays can be extracted to a file called TODAY.BIR by using 
  131. the program BDAYPREP.EXE.   BDAYPREP will extract user birthdays from Wildcat!
  132. 2.x and 3.x data files.    TODAY.BIR must be placed in the same directory 
  133. with your other TODAY.xxx data files.  If you don't already have BDAYPREP, 
  134. you can obtain it from the Cabin.  See above.
  135.  
  136. Run BDAYPREP during your daily maintenance (or some less frequent interval, but
  137. often enough to update new users' birthdays).  Start BDAYPREP in the directory
  138. where your user database file is located, and give it the output pathname on the
  139. command line ... something like this:
  140.  
  141. CD C:\WC30
  142. BDAYPREP C:\TODAY\
  143.  
  144. ------------------------------------------------------------------
  145. PROBLEMS, SUGGESTIONS:
  146.  
  147. This program is public domain.  I don't seek or accept any donations for 
  148. this  or any of my other Wildcat! utility programs, including TODAYBBS, 
  149. FLOP, MSTAT, USTAT, and others.
  150.  
  151. I welcome suggestions, and will try to help (no guarantees) if there are
  152. problems.
  153.  
  154. You may contact me at The Charlatan's Cabin BBS  (213) 654-7337.  Mention
  155. your Wildcat! registration number in the comment and you'll be upgraded to
  156. visiting sysop level without the usually required registration by mail.
  157.  
  158. You may also leave a message via CompuServe EMail. My CompuServe account 
  159. number is 70250,220.  I also regularly check the Mustang Software head-
  160. quarters BBS, especially the "3rd Party Utilities Help" conference.
  161.  
  162. Please, NO VOICE CALLS.  This isn't meant to be unfriendly, but with the 
  163. price of public domain software these days ... I just can't afford to be 
  164. "on call."  I WILL respond to your questions via my BBS or CompuServe,
  165. or via the Mustang Software registered SysOp BBS.
  166.  
  167. Version history:
  168.  
  169. 3.00     11/16/91       First release compatible with Wildcat! 3.x as well
  170.                         as Wildcat! 2.x
  171. 3.01     11/22/91       Minor update ... added parsing to display time left
  172.                         on sysop window at bottom of screen for systems 
  173.                         using DOOR.SYS
  174. 3.02     11/24/91       Added support for non-standard port addresses.
  175. 3.03     12/08/91       Minor bug fix to handle backspace from remote when
  176.                         input line is empty.
  177. 3.04     01/19/92       Fixed local console display when display line was 
  178.                         to be erased in local mode.
  179. 3.05                    (not released)
  180. 3.06     02/07/92       Recompiled with QBSerial 2.1 by Jeff Sumberg, more
  181.                         reliable on a multi-tasking machine.
  182. 3.07     03/30/92       Added auto-detection of file YEAR order, re-sequence
  183.                         if required so that newest years appear first in the
  184.                         display.   Note: This is not a FULL sort, but rather
  185.                         a check whether the order is ascending or descending,
  186.                         with the output sequence reversed if the years ascend
  187.                         in the file.
  188. 3.10     06/15/92       Recompiled with QBSerial 2.2 by Jeff Sumberg, adding
  189.                         support for high IRQs.  Also fixed a bug which could
  190.                         "leak" header information on some long text from the
  191.                         TODAY.xxx file.
  192. 3.11     07/05/92       Recompiled with QBSerial 2.25 by Jeff Sumberg.
  193. 3.12     07/28/92       Fixed possible range overrun if data file contained
  194.                         too many entries for a particular date.
  195. 3.13     11/04/92       Fixed line-wrap if tabs were encountered in the file
  196.                         instead of expected spaces.
  197. 3.20     12/19/92       Added FOSSIL support with QBSerial 3.00 by Jeff
  198.                         Sumberg.  Requires configuration file update.
  199.  
  200.